Query authorizations

Fetch specific authorization

Use this endpoint to fetch information about an Automatic Pix authorization

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations/:identifier'

Headers

Name	Description
x-delbank-api-key	Required. API key

Path Parameters:

Name	Type	Description
identifier	string	Required. Authorization identifier

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
    "id": "RR999999182025050751897433907",
    "RecurrentRequestId": "SC3822485720250507Q5fbI7GDMi9",
    "journey": 3,
    "tpFrequencia": 1,
    "dtInicialRecorrencia": "2025-06-01",
    "dtFinalRecorrencia": "2025-12-30",
    "valor": 100.50,
    "beneficiary": {
        "ispb": 21018182,
        "document": 76961727000105,
		"type": "LEGAL",
        "name": "Demo Pix Automatico"
    },
    "payer": {
        "type": "NATURAL",
        "document": "5876932582",
        "name": "Alisson Oliveira Neves ",
		"bank":
		{
			"number": "42790"
			"ispb": 38224857,
			"branch": "1",
			"type": "CURRENT",
		},
        "cityCode": 2800308
    },
    "debtor": {
        "type": "NATURAL",
        "document": "5876932582",
        "name": "Renan Cesar Nunes ",
    },
    "contract:
	{
		Number": "1234556",
    	"description": "1234556",
	},	
    "createdAt": "2025-05-07T10:30:00.000Z",
    "updatedAt": "2025-05-07T13:24:28.848Z"
}

Fetch all authorizations

This endpoint will fetch all the authorizations, be them sent or received

Request

GET 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorizations'

Headers

Name	Description
x-delbank-api-key	Required. API key

Path Parameters:

Name	Type	Description
flow	enum	Which journey to search for, values: 1, 2, 3, 4
startDate	date	The start date of the query
endDate	date	The end date of the query
page	number	The page number. Use this to paginate results depending on pageSize
pageSize	number	The amount of results returned per page
payerDocument	string	CPF or CNPJ
payerType	enum	0 for CPF or 1 for CNPJ

Response

The status code 200 indicates success in the query.

Being succeeded, the return will have the following fields in Json format:

{
	"autorizacoes": [
		{
			"id":"RR0435879820240605njua7shf40o",
			"idempotencyKey":"70F945C1-9024-4123-1001-A1DE2A0000D1",
			"authorizationResult":true,
			"journey":1,
			"frequencyType":4,
			"startDate":"2024-01-10",
			"endDate":"2026-01-10",
			"amount":550,
			"beneficiary": {
				"ispb":4358798,
				"document":61695227000193,
				"name":"Enel"
			},
			"payer": {
				"ispb":99999004,
				"type":0,
				"document":11111111111,
				"branch":"1234",
				"number":"12345678",
			},
			"debtor": {
				"type":0,
				"document":4623217035,
				"name":"Ciclano da Silva"
			},
			"contractNumber":"1234567890ABC",
			"description":"Conta de energia",
		}
		{
			"id":"RR0435879820240605njua7shf40o",
			"idempotencyKey":"70F945C1-9024-4123-1001-A1DE2A0000D1",
			"authorizationResult":true,
			"journey":1,
			"frequencyType":4,
			"startDate":"2024-01-10",
			"endDate":"2026-01-10",
			"amount":550,
			"beneficiary": {
				"ispb":4358798,
				"document":61695227000193,
				"name":"Enel"
			},
			"payer": {
				"ispb":99999004,
				"type":0,
				"document":11111111111,
				"branch":"1234",
				"number":"12345678",
			},
			"debtor": {
				"type":0,
				"document":4623217035,
				"name":"Ciclano da Silva"
			},
			"contractNumber":"1234567890ABC",
			"description":"Conta de energia",
			"cancellingData": [
				{
					"cancelId":"IC0435879820240627acbd4fhn26b",
					"debtorType":0,
					"debtorDocument":11111111111,
					"cancelReason":7,
					"cancelDate":"2024-06-07T11:24:48.047Z",
					"cancelStatus":0
				}
				{
					"cancelId":"IC0435879820240627acbd4fhn26b",
					"debtorType":0,
					"debtorDocument":11111111111,
					"cancelReason":7,
					"cancelDate":"2024-06-07T11:24:48.047Z",
					"cancelStatus":0
				}
			]
		}
	]
}